<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
                "http://www.w3.org/TR/REC-html40/loose.dtd">
<html>
<head>
  <title>Description of tfsapl</title>
  <meta name="keywords" content="tfsapl">
  <meta name="description" content="tfsapl      Time-frequency plot">
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  <meta name="generator" content="m2html &copy; 2003 Guillaume Flandin">
  <meta name="robots" content="index, follow">
  <link type="text/css" rel="stylesheet" href="../m2html.css">
</head>
<body>
<a name="_top"></a>
<!-- menu.html hdocs -->
<h1>tfsapl
</h1>

<h2><a name="_name"></a>PURPOSE <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
<div class="box"><strong>tfsapl      Time-frequency plot</strong></div>

<h2><a name="_description"></a>DESCRIPTION <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
<div class="fragment"><pre class="comment"> tfsapl      Time-frequency plot

 p = tfsapl( time, TFD [, Properties ] )
                           
 Plot the time    series (vector time) and the time-frequency
 distribution matrix TFD.


 PROPERITES
 ----------

 List of optional properties to set the apperance of the plot.
 Should be specified as ..., 'ParameterName', 'Value', .... They are
 not case sensitive. E.g.
 tfsapl( time, TFD, 'TimePlot', 'on', 'FreqPlot', 'on', 'plotfn', ...
 'surf', 'Title', 'Time Frequency Distribution', 'FontSize', 12 )


 TimePlot: {'on'|'off'}  (default 'off')
 Plot of time domain signal appears along y-axis 

 FreqPlot: {'on'|'off'}  (default 'off')
 Plot of spectrum appears along x-axis 

 SampleFreq: { numeric value }  (default 1)
 Set sampling frequency.

 Res: { numeric value }  (default 1)
 Time resolution value.

 PlotFn: { 'surf', 'contour', etc. }  (default 'tfsapl') 
 Name of function that will plot the TFD. It must be a function that
 takes three arguments: (xaxis,yaxis,data).  

 ExtraArgs: { string of commands } ( default '' ) 
 Extra arguments for 'PlotFn'; string of commands that will be
 executed using the 'eval' function. Used in

 Title: { string }   ( default '' )
 String containing title of plot

 XLabel: { string }   ( default 'Frequency (Hz)' )
 String containing label for x-axis.

 YLabel: { string }   ( default 'Time (s)' )
 String containing label for y-axis.

 TFfontSize: { numeric } ( default 14 )
 Font size in points for 'Title', 'XLabel' and 'YLabel'.

 Zoom: { vector of length 4 } ( default [0 1 0 1] )
 Start an end magnification of TFD matrix in x and y directions.

 TFlog: { 'on' | 'off' }  ( default 'off' )
 If 'on' the log of the TFD is plotted.

 TFGrid: { 'on' | 'off' }  ( default 'off' )
 Turn on/off the grid on the TFD plot. (Won't effect 'tfsapl'
 plot)

 GrayScale: { 'on' | 'off' } ( default 'off' )
 Plots will be specified in grayscale overriding any values
 relating to colour scheme.

 TFShading: { 'flat' | 'interp' | 'faceted' } (default 'faceted' )
 Selects the shading type for the TFD plot. (Won't effect 'tfsapl' plot)
 
 TFColourMap: { 'jet', 'bone', etc }  ( default 'jet' )
 Colourmap for TFD plot. (Won't effect 'tfsapl' plot)

 TFInvert: { 'on' | 'off' }  ( default 'off' )
 Invert the colourmap for TFD plot. (Won't effect 'tfsapl' plot)

 TFLine: { 'black', 'white', etc } ( default 'cyan' )
 Line colour for tfsapl plot ONLY.

 TFBackGround: { 'black', 'white', etc } ( default 'black' )
 Background colour for tfsapl plot ONLY.

 TimeLine: { 'black', 'white', etc } ( default depends of 'plotfn' )
 Line colour for time domain plot. 

 TimeBackground: { 'black', 'white', etc } ( default depends of 'plotfn' )
 Background colour for time domain plot. 

 TimeGrid: { 'on'|'off' } ( default 'off' )
 Turn on/off grid for time domain plot.

 TimeDetails: { 'on'|'off' } ( default 'on' )
 Turn on/off text displaying sampling information of time signal.

 FreqLine: { 'black', 'white', etc } ( default depends of 'plotfn' )
 Line colour for frequency domain plot. 

 FreqBackground: { 'black', 'white', etc } ( default depends of 'plotfn' )
 Background colour for frequency domain plot. 

 FreqGrid: { 'on'|'off' } ( default 'off' )
 Turn on/off grid for frequency domain plot.

 FigHandle: { handle of figure } (default none)
 Specify figure handle if plots are to go over whats there.
 Otherwise a new figure will be created or current figure 
 will be cleared.

 RETURN
 ------
 The return value 'p' is a vector containing four graphics axis handles,
 p(1) is the time signal
 p(2) is the power spectrum
 p(3) is the time-frequency plot
 p(4) is the title information    at the top

 These can be used to alter the appearence of the plot after it is
 complete, with set(p(i),'Parameter',value) commands.</pre></div>

<!-- crossreference -->
<!-- removed -->
<!-- crossreference -->



<hr><address>Generated by <strong><a href="http://www.artefact.tk/software/matlab/m2html/" target="_parent">m2html</a></strong> &copy; 2016</address>
</body>
</html>